home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v1.1 / Amiga Developer CD v1.1 - May 1996 (1996)(Schatztruhe)[!].iso / Contributions / IAM / Networking / Envoy-2.0 / obs / svc_lib.doc < prev    next >
Text File  |  1994-12-22  |  5KB  |  141 lines
  1. TABLE OF CONTENTS
  2.  
  3. xxx.service/AttemptShutdown
  4. xxx.service/GetServiceAttrsA
  5. xxx.service/SetServiceAttrsA
  6. xxx.service/StartService
  7. xxx.service/AttemptShutdown                       xxx.service/AttemptShutdown
  8.  
  9.    NAME
  10.        AttemptShutdown -- Inform a service that the system will be going down
  11.  
  12.    SYNOPSIS
  13.        AttemptShutdown(desc, seconds)
  14.                        A0    D0
  15.  
  16.        VOID AttemptShutdown(STRPTR, ULONG)
  17.  
  18.    FUNCTION
  19.        This function provides a means for informing a service as a whole that
  20.        it should try to shutdown within a specified amount of time.
  21.  
  22.    INPUTS
  23.        desc - Pointer to a string that contains a user-friendly reason of
  24.            why the service needs to be shut down.  May be NULL.
  25.  
  26.        seconds - The number of seconds until the end of the world.  This may
  27.            be 0 if shutdown needs to be done immediately.
  28.  
  29.    NOTES
  30.        This function is provided as a convenience to services such as
  31.        filesystems that may wish to start refusing new connections and/or
  32.        flush any buffered data to disk.
  33.  
  34. xxx.service/GetServiceAttrsA                     xxx.service/GetServiceAttrsA
  35.  
  36.    NAME
  37.        GetServiceAttrsA -- obtain information about the service.
  38.        GetServiceAttrs -- varargs stub for GetServiceAttrsA.
  39.  
  40.    SYNOPSIS
  41.        GetServiceAttrsA(taglist)
  42.                         A0
  43.  
  44.        VOID GetServiceAttrsA(struct TagItem *);
  45.  
  46.        GetServiceAttrs(tag1, ...)
  47.  
  48.        VOID GetServiceAttrs(Tag, ...);
  49.  
  50.    FUNCTION
  51.        This function provides a method for determining information about
  52.        the service.  Some of this data will be used by Services Manager
  53.        for configuration.  There will also likely be a predefined set
  54.        of Tags for information such as the names of the connected users,
  55.        the current load on the service, etc.  Service implementors will
  56.        also be able to define their own custom Tags for diagnostic/
  57.        statistical purposes.
  58.  
  59.    INPUTS
  60.        taglist - A tagList containing the tags that you want to get the
  61.            attributes for.
  62.  
  63.    TAGS
  64.        Tags defined for GetServiceAttrsA():
  65.  
  66.        SVCAttrs_Name (STRPTR) - The name of the service you are providing.
  67.            (Required)
  68.  
  69.  
  70. xxx.service/SetServiceAttrsA                     xxx.service/SetServiceAttrsA
  71.  
  72.    NAME
  73.        SetServiceAttrsA -- set attributes of a service.
  74.        SetServiceAttrs -- varargs stub for SetServiceAttrs
  75.  
  76.    SYNOPSIS
  77.        SetServiceAttrsA(taglist)
  78.                         A0
  79.  
  80.        VOID SetServiceAttrsA(struct TagItem *);
  81.  
  82.        SetServiceAttrs(tag1, ...)
  83.  
  84.        VOID SetServiceAttrs(Tag, ...);
  85.  
  86.    FUNCTION
  87.        This function provides a method for setting attributes for a service.
  88.        For instance, a configuration editor for the service may need to
  89.        change the name of the service, permissions, etc.  This function
  90.        provides a standardized method for doing so.
  91.  
  92.    INPUTS
  93.        taglist - A list of TagItem structures to be used by the service
  94.            to modify it's operation.
  95.  
  96.    TAGS
  97.        Tags defined for SetServiceAttrsA():
  98.  
  99.        SVCAttrs_Name (STRPTR)  - The name of the service you are providing.
  100.  
  101. xxx.service/StartService                             xxx.service/StartService
  102.  
  103.    NAME
  104.        StartService -- Accept a new client connection
  105.  
  106.    SYNOPSIS
  107.        error = StartService(taglist)
  108.        d0                   A0
  109.  
  110.        ULONG StartService(struct TagItem *);
  111.  
  112.    FUNCTION
  113.        This function requests that a service take whatever steps are
  114.        required to initiate a connection with a new client. The service
  115.        should fill in entityName with the name of the Entity with which
  116.        you will be accepting client transactions.  If you have any kind
  117.        of problem during startup, return with a non-zero error code. This
  118.        code will be passed back to the client that called FindService().
  119.  
  120.    INPUTS
  121.        taglist - Pointer to an array of TagItem's passed in by the
  122.            Services Manager.
  123.  
  124.    TAGS
  125.        Tags defined for use with StartService():
  126.  
  127.        SSVC_UserName (STRPTR) - The name of the user requesting your
  128.                service.
  129.        SSVC_Password (STRPTR) - The password of the user requesting your
  130.                services.
  131.        SSVC_HostName (STRPTR) - The hostname of the machine from which
  132.                the client is connecting.
  133.        SSVC_EntityName (STRPTR) - The buffer to fill in with the name of
  134.                the Entity that the client should connect to.
  135.  
  136.    RESULT
  137.        error - A ULONG describing why you could not start your service. This
  138.            error code will be passed back to the client that called
  139.            FindService().
  140.  
  141.